home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1996 November / macformat-043.iso / mac / Shareware Plus / Developers / Sprite Animation Toolkit 2.3.8 / SAT Think Lib ƒ / SAT.h < prev    next >
Encoding:
C/C++ Source or Header  |  1996-06-20  |  10.1 KB  |  280 lines  |  [TEXT/KAHL]
  1. /* #include file for the C interface to SAT */
  2.  
  3. #pragma once
  4. #ifdef __cplusplus
  5. extern "C" {
  6. #endif
  7.  
  8. #pragma options align=mac68k
  9.  
  10. #ifndef true
  11. #define true 1
  12. #endif
  13.  
  14. #ifndef false
  15. #define false 0
  16. #endif
  17.  
  18. #ifndef nil
  19. #define nil 0L
  20. #endif
  21.  
  22.     typedef struct SATPort {
  23.         GrafPtr        port;
  24.         GDHandle    device;
  25.         Ptr                rows;
  26.         Rect            bounds;
  27.         Ptr                baseAddr;
  28.         short            rowBytes;
  29.     } SATPort;
  30.  
  31.     typedef struct Face {
  32.         char            *colorData;
  33.         short            resNum;
  34.         BitMap            iconMask;
  35.         short            rowBytes; /* Note! No flags in the highest bits!*/
  36.         struct face        *next;
  37.         RgnHandle        maskRgn;
  38.         Ptr    rows, maskRows;
  39.         pascal void (*redrawProc)(struct Face *, short);    //Called on depth changes, not needed if the face is loaded from a cicn}
  40.         pascal void (*drawProc)(struct Face *, RgnHandle, SATPort *, Point srcPt, Point dstPt, short width, short height); // Untested from C so far!
  41.         } Face, *FacePtr;
  42.  
  43.     typedef struct Sprite {
  44. /* Variables that you should change as appropriate */
  45.         short            kind;
  46.         Point            position;
  47.         Rect            hotRect, hotRect2;    // Only change hotRect, SAT handles hotRect2
  48.         FacePtr            face;
  49.         pascal void        (*task) (struct Sprite *);
  50.         pascal void        (*hitTask) (struct Sprite *, struct Sprite *);
  51.         pascal void        (*destructTask) (struct Sprite *);
  52.         RgnHandle        clip; /* Clip region to be used when this sprite is drawn. */
  53. /* SAT variables that you shouldn't change: */
  54.         Point            oldpos;
  55.         struct Sprite    *next, *prev;
  56.         Rect            r, oldr;
  57.         FacePtr        oldFace;            //Used by RunSAT2
  58.         Boolean        dirty;        //Used by RunSAT2
  59. /* Variables for free use by the application: */
  60.         short        layer;
  61. #ifdef SATCPP_H
  62.       Ptr            spriteBegin;
  63. #else
  64.         Point            speed;
  65.         short        mode;
  66.         Ptr            appPtr;
  67.         long            appLong;
  68. #endif
  69.         } Sprite, *SpritePtr;
  70.  
  71.  
  72. typedef struct{
  73.         short    patternType;     /* 1 = Pattern, PatHandle, 2 = PixPat, PixPatHandle */
  74.         PixPatHandle    thePat;         /* or PatHandle */
  75.         }    SATPattern, *SATPatPtr, **SATPatHandle;
  76.  
  77. #define    UpdatePtr    Ptr
  78.  
  79. typedef struct {
  80.         SATPort        wind;
  81.         short            offSizeH, offSizeV;
  82.         SATPort        offScreen, backScreen;
  83.         long            ox, oy;
  84.         short            pict, bwpict;
  85.         Boolean        fitThePICTs;
  86.         short            sorting, collision, searchWidth;
  87.         PixMapHandle    screen;
  88.         Rect            bounds;
  89.         short            initDepth;
  90.         pascal Boolean    (*synchHook) ();
  91.         SpritePtr        sRoot;
  92.         UpdatePtr        updateRoot;
  93.         Boolean        anyMonsters;
  94.  
  95.         CGrafPtr        ditherOff;
  96.         GDHandle        ditherOffGD;
  97.         SATPort            iconPort;
  98.         SATPort            iconPort2;
  99.         GrafPtr            bwIconPort;
  100.  
  101. /* Environment-independent globals: */
  102.         FacePtr            faceRoot;    /* Face list */
  103.         Boolean            colorFlag; /* Is this Mac color capable? */
  104. /*Blitters! You should not change these fields yourself. (Possibly for installing a blitter in your program code.)*/
  105.         ProcPtr    rectBlit1, maskBlit1;                //{Supplied - this is either RBlt/MBlt 0 or 1}
  106.         ProcPtr    rectBlit2, maskBlit2;                //{Will probably never be used}
  107.         ProcPtr    rectBlit4, maskBlit4;                //{Supplied}
  108.         ProcPtr    rectBlit8, maskBlit8;                //{Supplied}
  109.         ProcPtr    rectBlit16, maskBlit16;            //{Not supplied}
  110.         ProcPtr    rectBlit32, maskBlit32;            //{Not supplied}
  111.         ProcPtr    curRectBlit, curMaskBlit;        //{Currently selected fast blitter}
  112.  
  113.         Rect    screenLocalDrawingArea;
  114.         SpritePtr    trashList;
  115.         } SATglobalsRec;
  116.  
  117. /* Constants for SATConfigure */
  118.     enum{kVPositionSort=0, kLayerSort, kNoSort};
  119.     enum{kKindCollision=0, kForwardCollision, kBackwardCollision, kNoCollision, kForwardOneCollision};
  120.  
  121. // For CodeWarrior C, 68k (due to capitalization problems):
  122. // Note: If you have link problems associated with gSAT, you may have
  123. // to activate or deactivate this #define!
  124. #ifdef __MWERKS__
  125. #ifndef powerc
  126. #define gSAT GSAT
  127. #endif
  128. #endif
  129.  
  130. /* Global variables */
  131.     extern SATglobalsRec    gSAT;    /* Most globals */
  132.     extern pascal void        (*gSoundErrorProc)(OSErr); /* Sound errors reported here */
  133.  
  134. /* SAT routines */
  135.  
  136.     typedef pascal void (*TaskPtr)(SpritePtr);
  137.     typedef pascal Boolean (*SynchPtr)(void);
  138.     typedef pascal void (*EmergencyPtr)(void);
  139.  
  140. /* Initialization */
  141.     pascal void SATConfigure(Boolean, short, short, short);
  142.     pascal void SATInit (short, short, short, short);
  143.     pascal void SATCustomInit (short, short, Rect *, WindowPtr, GDHandle, Boolean, Boolean, Boolean, Boolean, Boolean);
  144. /* Maintainance, background manipulation etc. */
  145.     pascal Boolean SATDepthChangeTest(void);
  146.     pascal void SATDrawPICTs (short, short);
  147.     pascal void SATRedraw(void);
  148. /* Drawing */
  149.     pascal void SATPlotFace(FacePtr, SATPort*, Point, Boolean); /*Draw a Face (icon).*/
  150.     pascal void SATPlotFaceToScreen(FacePtr, Point, Boolean);
  151.     pascal void SATCopyBits(SATPort*, SATPort*, GDHandle, Rect*, Rect*, Boolean);
  152.     pascal void SATCopyBitsToScreen(SATPort*, Rect*, Rect*, Boolean);
  153.     pascal void SATBackChanged (Rect *); /*Tell SAT about changes in BackScreen*/
  154. /* SetPort replacements */
  155.     pascal void SATGetPort (SATPort*);
  156.     pascal void SATSetPort (SATPort*);
  157.     pascal void SATSetPortOffScreen(void); /*Use before Quick-Drawing on offScreen*/
  158.     pascal void SATSetPortBackScreen(void); /*Use before Quick-Drawing on BackScreen*/
  159.     pascal void SATSetPortScreen(void); /*Use to restore after drawing off/backscreen*/
  160. /* Sprite handling */
  161.     pascal FacePtr SATGetFace (short);
  162.     pascal void SATDisposeFace (FacePtr);
  163.     pascal SpritePtr SATNewSprite (short,short,short, TaskPtr); // (*void)(SpritePtr));
  164.     pascal SpritePtr SATNewSpriteAfter (SpritePtr,short,short,short, TaskPtr);
  165.     pascal void SATKillSprite (SpritePtr);
  166. /* Animating */
  167.     pascal void SATRun (Boolean);
  168.     pascal void    SATRun2 (Boolean); //Alternate routine for allowing resting sprites}
  169. /* Advanced special-purpose calls */
  170.     pascal void SATInstallSynch (SynchPtr);
  171.     pascal void SATInstallEmergency (EmergencyPtr);
  172.     pascal void SATSetSpriteRecSize (long);
  173.     pascal void SATSkip(void);
  174.     pascal void SATKill(void); /*Dispose of offscreen buffers to allow re-init*/
  175.     pascal void SATWindMoved(void);            /* For programs with moveable animation window and fast animation */
  176. /* Offscreen - use only if you need an *extra* offscreen buffer. These calls are likely to change in the future!*/
  177.     pascal void SATMakeOffscreen (SATPort*, Rect*);    /*Make offscreen buffer in current screen depth and CLUT.*/
  178.     pascal void SATDisposeOffScreen (SATPort*);        /*Get rid of offscreen*/
  179.     pascal OSErr CreateOffScreen (Rect*, short, CTabHandle, CGrafPtr*, GDHandle*); /*From Principia Offscreen*/
  180.     pascal void DisposeOffScreen (CGrafPtr, GDHandle);            /*From Principia Offscreen*/
  181. /* Face manipulation */
  182.     pascal void SATSetPortMask (FacePtr);
  183.     pascal void SATSetPortFace (FacePtr);
  184.     pascal void SATSetPortFace2 (FacePtr);
  185.     pascal FacePtr SATNewFace (Rect*);
  186.     pascal void SATChangedFace (FacePtr);
  187.  
  188. /* Most common old names, uncomment for compatibility with old programs */
  189. // #define ConfigureSAT        SATConfigure
  190. // #define InitSAT            SATInit
  191. // #define CustomInitSAT    SATCustomInit
  192. // #define KillSAT            SATKill
  193. // #define RunSAT            SATRun
  194. // #define SkipSAT            SATSkip
  195. // #define GetFace            SATGetFace
  196. // #define DisposeFace        SATDisposeFace
  197. // #define NewSprite        SATNewSprite
  198. // #define NewSpriteAfter    SATNewSpriteAfter
  199. // #define KillSprite        SATKillSprite
  200. // #define NewFace            SATNewFace
  201. // #define ChangedFace        SATChangedFace
  202. // #define PeekOffscreen    SATRedraw
  203.  
  204. /* New procedures, EXPERIMENTAL, intended for making a C++ interface */
  205.     pascal SpritePtr SATNewSpritePP(SpritePtr, Ptr, short, short, short, TaskPtr);
  206.     pascal void SATCopySprite(SpritePtr, const Sprite *);
  207. //    pascal void SATCopySprite(SpritePtr, SpritePtr);
  208.     pascal FacePtr SATNewFacePP(Rect*, Ptr);
  209.     pascal FacePtr SATGetFacePP (short, Ptr);
  210.     pascal void SATCopyFace(FacePtr, const Face *);
  211. //    pascal void SATCopyFace(FacePtr, FacePtr);
  212.     pascal void SATDisposeFacePP (FacePtr);
  213.  
  214. /* Cicn utilities */
  215.     pascal CIconHandle SATGetCicn (short);
  216.     pascal void SATPlotCicn (CIconHandle, GrafPtr, GDHandle, Rect*);
  217.     pascal void SATDisposeCicn (CIconHandle);
  218.  
  219. /*Utilities*/
  220.     pascal void SATSetStrings (Str255, Str255, Str255, Str255, Str255, Str255, Str255, Str255);
  221.     pascal Boolean SATTrapAvailable (short);
  222.     pascal void SATDrawInt (short);
  223.     pascal void SATDrawLong (long);
  224.     pascal short SATRand (short);
  225.     pascal short SATRand10(void);
  226.     pascal short SATRand100(void);
  227.     pascal void SATReportStr (Str255);
  228.     pascal Boolean SATQuestionStr(Str255);
  229.     pascal void CheckNoMem (Ptr); /*If the Ptr is nil, out of memory emergency exit*/
  230.     pascal short SATFakeAlert (Str255, Str255, Str255, Str255, short, short, short, Str255, Str255, Str255);
  231.     pascal void SATSetMouse (Point);
  232.     pascal void SATInitToolbox(void);
  233.     pascal void SATGetVersion(Str255 versionString);
  234. /* Pattern utilities */
  235.     pascal void SATPenPat (SATPatHandle);
  236.     pascal void SATBackPat (SATPatHandle);
  237.     pascal SATPatHandle SATGetPat (short);
  238.     pascal void SATDisposePat (SATPatHandle);
  239. /* Menu bar utilities */
  240.     pascal void SATShowMBar(WindowPtr);
  241.     pascal void SATHideMBar(WindowPtr);
  242. /* PICT utilities */
  243.     pascal void SATGetandDrawPICTRes (short id);
  244.     pascal void SATGetandDrawPICTResInRect (short id, Rect *frame);
  245.     pascal void SATGetandCenterPICTResInRect (short id, Rect *frame);
  246. /*Sound*/
  247.     pascal void SATInitSound(void);            /* No longer necessary */
  248.     pascal void SATSoundPlay (Handle, short, Boolean);    /* Play sounds with priority handling */
  249.     pascal void SATSoundShutup(void);        /*Silence, dispose of sound channel*/
  250.     pascal void SATSoundEvents(void);        /* Call this once in a while when not calling RunSAT often */
  251.     pascal Boolean SATSoundDone(void);    /* Any sound going on?*/
  252.     pascal Handle SATGetSound (short);
  253.     pascal Handle SATGetNamedSound (Str255);
  254.     pascal void SATDisposeSound (Handle);
  255.     pascal void SATSoundOn(void);
  256.     pascal void SATSoundOff(void);
  257. /* Multi-channel sound routines */
  258.     pascal short SATSoundInitChannels (short);
  259.     pascal Boolean SATSoundDoneChannel (short);
  260.     pascal void SATSoundPlayChannel (Handle, short);
  261.     pascal void SATSoundReserveChannel (short, Boolean);
  262.     pascal void SATSoundShutupChannel (short);
  263.     pascal void SATPreloadChannels(void);
  264. /* Experimental, likely to be renamed/removed/changed: */
  265.     pascal void SATSoundPlay2 (Handle, short, Boolean,Boolean);
  266.     pascal void SATSoundPlayEasy (Handle, Boolean);
  267. /* More multi-channel: */
  268.     pascal int SATGetNumChannels(void);
  269.     pascal Ptr SATGetChannel (int);
  270. /* Customization */
  271.     pascal void SATSetSoundInitParams (long);
  272. /* Step-scrolling */
  273.     pascal Boolean SATStepScroll (Point viewPoint, short marginH, short marginV, short scrollSpeed);
  274.  
  275. #pragma options align=reset
  276.  
  277. #ifdef __cplusplus
  278. }
  279. #endif
  280.